@backstage-community/plugin-badges-backend 0.5.2 → 0.5.4

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @backstage-community/plugin-badges-backend
 
+## 0.5.4
+
+### Patch Changes
+
+- 1f907f2: Deprecated `createRouter` and its router options in favour of the new backend system.
+
+## 0.5.3
+
+### Patch Changes
+
+- b9e206b: Backstage version bump to v1.32.2
+
 ## 0.5.2
 
 ### Patch Changes

package/dist/badges.cjs.js

@@ -0,0 +1,85 @@
+'use strict';
+
+var catalogModel = require('@backstage/catalog-model');
+var errors = require('@backstage/errors');
+
+function appTitle(context) {
+  return context.config.getOptionalString("app.title") || "Backstage";
+}
+function entityUrl(context) {
+  const e = context.entity;
+  const entityUri = `${e.metadata.namespace || catalogModel.DEFAULT_NAMESPACE}/${e.kind}/${e.metadata.name}`;
+  const catalogUrl = `${context.config.getString("app.baseUrl")}/catalog`;
+  return `${catalogUrl}/${entityUri}`.toLowerCase();
+}
+const createDefaultBadgeFactories = () => ({
+  pingback: {
+    createBadge: (context) => {
+      if (!context.entity) {
+        throw new errors.InputError('"pingback" badge only defined for entities');
+      }
+      return {
+        description: `Link to ${context.entity.metadata.name} in ${appTitle(
+          context
+        )}`,
+        kind: "entity",
+        label: context.entity.kind,
+        link: entityUrl(context),
+        message: context.entity.metadata.name,
+        style: context.style || "flat-square",
+        color: context.color
+      };
+    }
+  },
+  lifecycle: {
+    createBadge: (context) => {
+      if (!context.entity) {
+        throw new errors.InputError('"lifecycle" badge only defined for entities');
+      }
+      return {
+        description: "Entity lifecycle badge",
+        kind: "entity",
+        label: "lifecycle",
+        link: entityUrl(context),
+        message: `${context.entity.spec?.lifecycle || "unknown"}`,
+        style: context.style || "flat-square",
+        color: context.color
+      };
+    }
+  },
+  owner: {
+    createBadge: (context) => {
+      if (!context.entity) {
+        throw new errors.InputError('"owner" badge only defined for entities');
+      }
+      return {
+        description: "Entity owner badge",
+        kind: "entity",
+        label: "owner",
+        link: entityUrl(context),
+        message: `${context.entity.spec?.owner || "unknown"}`,
+        style: context.style || "flat-square",
+        color: context.color
+      };
+    }
+  },
+  docs: {
+    createBadge: (context) => {
+      if (!context.entity) {
+        throw new errors.InputError('"docs" badge only defined for entities');
+      }
+      return {
+        description: "Entity docs badge",
+        kind: "entity",
+        label: "docs",
+        link: `${entityUrl(context)}/docs`,
+        message: context.entity.metadata.name,
+        style: context.style || "flat-square",
+        color: context.color
+      };
+    }
+  }
+});
+
+exports.createDefaultBadgeFactories = createDefaultBadgeFactories;
+//# sourceMappingURL=badges.cjs.js.map

package/dist/badges.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"badges.cjs.js","sources":["../src/badges.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { DEFAULT_NAMESPACE } from '@backstage/catalog-model';\nimport { InputError } from '@backstage/errors';\nimport { Badge, BadgeContext, BadgeFactories } from './types';\n\nfunction appTitle(context: BadgeContext): string {\n  return context.config.getOptionalString('app.title') || 'Backstage';\n}\n\nfunction entityUrl(context: BadgeContext): string {\n  const e = context.entity!;\n  const entityUri = `${e.metadata.namespace || DEFAULT_NAMESPACE}/${e.kind}/${\n    e.metadata.name\n  }`;\n  const catalogUrl = `${context.config.getString('app.baseUrl')}/catalog`;\n  return `${catalogUrl}/${entityUri}`.toLowerCase();\n}\n\n/** @public */\nexport const createDefaultBadgeFactories = (): BadgeFactories => ({\n  pingback: {\n    createBadge: (context: BadgeContext): Badge => {\n      if (!context.entity) {\n        throw new InputError('\"pingback\" badge only defined for entities');\n      }\n      return {\n        description: `Link to ${context.entity.metadata.name} in ${appTitle(\n          context,\n        )}`,\n        kind: 'entity',\n        label: context.entity.kind,\n        link: entityUrl(context),\n        message: context.entity.metadata.name,\n        style: context.style || 'flat-square',\n        color: context.color,\n      };\n    },\n  },\n\n  lifecycle: {\n    createBadge: (context: BadgeContext): Badge => {\n      if (!context.entity) {\n        throw new InputError('\"lifecycle\" badge only defined for entities');\n      }\n      return {\n        description: 'Entity lifecycle badge',\n        kind: 'entity',\n        label: 'lifecycle',\n        link: entityUrl(context),\n        message: `${context.entity.spec?.lifecycle || 'unknown'}`,\n        style: context.style || 'flat-square',\n        color: context.color,\n      };\n    },\n  },\n\n  owner: {\n    createBadge: (context: BadgeContext): Badge => {\n      if (!context.entity) {\n        throw new InputError('\"owner\" badge only defined for entities');\n      }\n      return {\n        description: 'Entity owner badge',\n        kind: 'entity',\n        label: 'owner',\n        link: entityUrl(context),\n        message: `${context.entity.spec?.owner || 'unknown'}`,\n        style: context.style || 'flat-square',\n        color: context.color,\n      };\n    },\n  },\n\n  docs: {\n    createBadge: (context: BadgeContext): Badge => {\n      if (!context.entity) {\n        throw new InputError('\"docs\" badge only defined for entities');\n      }\n      return {\n        description: 'Entity docs badge',\n        kind: 'entity',\n        label: 'docs',\n        link: `${entityUrl(context)}/docs`,\n        message: context.entity.metadata.name,\n        style: context.style || 'flat-square',\n        color: context.color,\n      };\n    },\n  },\n});\n"],"names":["DEFAULT_NAMESPACE","InputError"],"mappings":";;;;;AAoBA,SAAS,SAAS,OAA+B,EAAA;AAC/C,EAAA,OAAO,OAAQ,CAAA,MAAA,CAAO,iBAAkB,CAAA,WAAW,CAAK,IAAA,WAAA,CAAA;AAC1D,CAAA;AAEA,SAAS,UAAU,OAA+B,EAAA;AAChD,EAAA,MAAM,IAAI,OAAQ,CAAA,MAAA,CAAA;AAClB,EAAA,MAAM,SAAY,GAAA,CAAA,EAAG,CAAE,CAAA,QAAA,CAAS,SAAa,IAAAA,8BAAiB,CAAI,CAAA,EAAA,CAAA,CAAE,IAAI,CAAA,CAAA,EACtE,CAAE,CAAA,QAAA,CAAS,IACb,CAAA,CAAA,CAAA;AACA,EAAA,MAAM,aAAa,CAAG,EAAA,OAAA,CAAQ,MAAO,CAAA,SAAA,CAAU,aAAa,CAAC,CAAA,QAAA,CAAA,CAAA;AAC7D,EAAA,OAAO,CAAG,EAAA,UAAU,CAAI,CAAA,EAAA,SAAS,GAAG,WAAY,EAAA,CAAA;AAClD,CAAA;AAGO,MAAM,8BAA8B,OAAuB;AAAA,EAChE,QAAU,EAAA;AAAA,IACR,WAAA,EAAa,CAAC,OAAiC,KAAA;AAC7C,MAAI,IAAA,CAAC,QAAQ,MAAQ,EAAA;AACnB,QAAM,MAAA,IAAIC,kBAAW,4CAA4C,CAAA,CAAA;AAAA,OACnE;AACA,MAAO,OAAA;AAAA,QACL,aAAa,CAAW,QAAA,EAAA,OAAA,CAAQ,MAAO,CAAA,QAAA,CAAS,IAAI,CAAO,IAAA,EAAA,QAAA;AAAA,UACzD,OAAA;AAAA,SACD,CAAA,CAAA;AAAA,QACD,IAAM,EAAA,QAAA;AAAA,QACN,KAAA,EAAO,QAAQ,MAAO,CAAA,IAAA;AAAA,QACtB,IAAA,EAAM,UAAU,OAAO,CAAA;AAAA,QACvB,OAAA,EAAS,OAAQ,CAAA,MAAA,CAAO,QAAS,CAAA,IAAA;AAAA,QACjC,KAAA,EAAO,QAAQ,KAAS,IAAA,aAAA;AAAA,QACxB,OAAO,OAAQ,CAAA,KAAA;AAAA,OACjB,CAAA;AAAA,KACF;AAAA,GACF;AAAA,EAEA,SAAW,EAAA;AAAA,IACT,WAAA,EAAa,CAAC,OAAiC,KAAA;AAC7C,MAAI,IAAA,CAAC,QAAQ,MAAQ,EAAA;AACnB,QAAM,MAAA,IAAIA,kBAAW,6CAA6C,CAAA,CAAA;AAAA,OACpE;AACA,MAAO,OAAA;AAAA,QACL,WAAa,EAAA,wBAAA;AAAA,QACb,IAAM,EAAA,QAAA;AAAA,QACN,KAAO,EAAA,WAAA;AAAA,QACP,IAAA,EAAM,UAAU,OAAO,CAAA;AAAA,QACvB,SAAS,CAAG,EAAA,OAAA,CAAQ,MAAO,CAAA,IAAA,EAAM,aAAa,SAAS,CAAA,CAAA;AAAA,QACvD,KAAA,EAAO,QAAQ,KAAS,IAAA,aAAA;AAAA,QACxB,OAAO,OAAQ,CAAA,KAAA;AAAA,OACjB,CAAA;AAAA,KACF;AAAA,GACF;AAAA,EAEA,KAAO,EAAA;AAAA,IACL,WAAA,EAAa,CAAC,OAAiC,KAAA;AAC7C,MAAI,IAAA,CAAC,QAAQ,MAAQ,EAAA;AACnB,QAAM,MAAA,IAAIA,kBAAW,yCAAyC,CAAA,CAAA;AAAA,OAChE;AACA,MAAO,OAAA;AAAA,QACL,WAAa,EAAA,oBAAA;AAAA,QACb,IAAM,EAAA,QAAA;AAAA,QACN,KAAO,EAAA,OAAA;AAAA,QACP,IAAA,EAAM,UAAU,OAAO,CAAA;AAAA,QACvB,SAAS,CAAG,EAAA,OAAA,CAAQ,MAAO,CAAA,IAAA,EAAM,SAAS,SAAS,CAAA,CAAA;AAAA,QACnD,KAAA,EAAO,QAAQ,KAAS,IAAA,aAAA;AAAA,QACxB,OAAO,OAAQ,CAAA,KAAA;AAAA,OACjB,CAAA;AAAA,KACF;AAAA,GACF;AAAA,EAEA,IAAM,EAAA;AAAA,IACJ,WAAA,EAAa,CAAC,OAAiC,KAAA;AAC7C,MAAI,IAAA,CAAC,QAAQ,MAAQ,EAAA;AACnB,QAAM,MAAA,IAAIA,kBAAW,wCAAwC,CAAA,CAAA;AAAA,OAC/D;AACA,MAAO,OAAA;AAAA,QACL,WAAa,EAAA,mBAAA;AAAA,QACb,IAAM,EAAA,QAAA;AAAA,QACN,KAAO,EAAA,MAAA;AAAA,QACP,IAAM,EAAA,CAAA,EAAG,SAAU,CAAA,OAAO,CAAC,CAAA,KAAA,CAAA;AAAA,QAC3B,OAAA,EAAS,OAAQ,CAAA,MAAA,CAAO,QAAS,CAAA,IAAA;AAAA,QACjC,KAAA,EAAO,QAAQ,KAAS,IAAA,aAAA;AAAA,QACxB,OAAO,OAAQ,CAAA,KAAA;AAAA,OACjB,CAAA;AAAA,KACF;AAAA,GACF;AACF,CAAA;;;;"}

package/dist/database/badgesStore.cjs.js

@@ -0,0 +1,50 @@
+'use strict';
+
+var backendCommon = require('@backstage/backend-common');
+var lodash = require('lodash');
+var uuid = require('uuid');
+
+const migrationsDir = backendCommon.resolvePackagePath(
+  "@backstage-community/plugin-badges-backend",
+  // Package name
+  "migrations"
+  // Migrations directory
+);
+class DatabaseBadgesStore {
+  constructor(db) {
+    this.db = db;
+  }
+  static async create({
+    database,
+    skipMigrations
+  }) {
+    const client = await database.getClient();
+    if (!database.migrations?.skip && !skipMigrations) {
+      await client.migrate.latest({
+        directory: migrationsDir
+      });
+    }
+    return new DatabaseBadgesStore(client);
+  }
+  async getBadgeFromUuid(uuid) {
+    const result = await this.db("badges").select("namespace", "name", "kind").where({ uuid }).first();
+    return result;
+  }
+  async getBadgeUuid(name, namespace, kind) {
+    const result = await this.db("badges").select("uuid").where({ name, namespace, kind }).first();
+    let uuid$1 = result?.uuid;
+    if (lodash.isNil(uuid$1)) {
+      uuid$1 = uuid.v4();
+      await this.db("badges").insert({
+        uuid: uuid$1,
+        name,
+        namespace,
+        kind
+      }).onConflict(["name", "namespace", "kind"]).ignore();
+    }
+    return { uuid: uuid$1 };
+  }
+}
+
+exports.DatabaseBadgesStore = DatabaseBadgesStore;
+//# sourceMappingURL=badgesStore.cjs.js.map

package/dist/database/badgesStore.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"badgesStore.cjs.js","sources":["../../src/database/badgesStore.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  PluginDatabaseManager,\n  resolvePackagePath,\n} from '@backstage/backend-common';\nimport { Knex } from 'knex';\nimport { isNil } from 'lodash';\nimport { v4 as uuidv4 } from 'uuid';\n\n/**\n * internal\n * @public\n */\nexport interface BadgesStore {\n  getBadgeUuid(\n    name: string,\n    namespace: string,\n    kind: string,\n  ): Promise<{ uuid: string }>;\n\n  getBadgeFromUuid(\n    uuid: string,\n  ): Promise<{ name: string; namespace: string; kind: string } | undefined>;\n}\n\nconst migrationsDir = resolvePackagePath(\n  '@backstage-community/plugin-badges-backend', // Package name\n  'migrations', // Migrations directory\n);\n\n/**\n * DatabaseBadgesStore\n * @internal\n */\nexport class DatabaseBadgesStore implements BadgesStore {\n  private constructor(private readonly db: Knex) {}\n\n  static async create({\n    database,\n    skipMigrations,\n  }: {\n    database: PluginDatabaseManager;\n    skipMigrations?: boolean;\n  }): Promise<DatabaseBadgesStore> {\n    const client = await database.getClient();\n\n    if (!database.migrations?.skip && !skipMigrations) {\n      await client.migrate.latest({\n        directory: migrationsDir,\n      });\n    }\n\n    return new DatabaseBadgesStore(client);\n  }\n\n  async getBadgeFromUuid(\n    uuid: string,\n  ): Promise<{ name: string; namespace: string; kind: string } | undefined> {\n    const result = await this.db('badges')\n      .select('namespace', 'name', 'kind')\n      .where({ uuid: uuid })\n      .first();\n\n    return result;\n  }\n\n  async getBadgeUuid(\n    name: string,\n    namespace: string,\n    kind: string,\n  ): Promise<{ uuid: string }> {\n    const result = await this.db('badges')\n      .select('uuid')\n      .where({ name: name, namespace: namespace, kind: kind })\n      .first();\n\n    let uuid = result?.uuid;\n\n    if (isNil(uuid)) {\n      uuid = uuidv4();\n\n      await this.db('badges')\n        .insert({\n          uuid: uuid,\n          name: name,\n          namespace: namespace,\n          kind: kind,\n        })\n        .onConflict(['name', 'namespace', 'kind'])\n        .ignore();\n    }\n\n    return { uuid };\n  }\n}\n"],"names":["resolvePackagePath","uuid","isNil","uuidv4"],"mappings":";;;;;;AAwCA,MAAM,aAAgB,GAAAA,gCAAA;AAAA,EACpB,4CAAA;AAAA;AAAA,EACA,YAAA;AAAA;AACF,CAAA,CAAA;AAMO,MAAM,mBAA2C,CAAA;AAAA,EAC9C,YAA6B,EAAU,EAAA;AAAV,IAAA,IAAA,CAAA,EAAA,GAAA,EAAA,CAAA;AAAA,GAAW;AAAA,EAEhD,aAAa,MAAO,CAAA;AAAA,IAClB,QAAA;AAAA,IACA,cAAA;AAAA,GAI+B,EAAA;AAC/B,IAAM,MAAA,MAAA,GAAS,MAAM,QAAA,CAAS,SAAU,EAAA,CAAA;AAExC,IAAA,IAAI,CAAC,QAAA,CAAS,UAAY,EAAA,IAAA,IAAQ,CAAC,cAAgB,EAAA;AACjD,MAAM,MAAA,MAAA,CAAO,QAAQ,MAAO,CAAA;AAAA,QAC1B,SAAW,EAAA,aAAA;AAAA,OACZ,CAAA,CAAA;AAAA,KACH;AAEA,IAAO,OAAA,IAAI,oBAAoB,MAAM,CAAA,CAAA;AAAA,GACvC;AAAA,EAEA,MAAM,iBACJ,IACwE,EAAA;AACxE,IAAA,MAAM,SAAS,MAAM,IAAA,CAAK,EAAG,CAAA,QAAQ,EAClC,MAAO,CAAA,WAAA,EAAa,MAAQ,EAAA,MAAM,EAClC,KAAM,CAAA,EAAE,IAAW,EAAC,EACpB,KAAM,EAAA,CAAA;AAET,IAAO,OAAA,MAAA,CAAA;AAAA,GACT;AAAA,EAEA,MAAM,YAAA,CACJ,IACA,EAAA,SAAA,EACA,IAC2B,EAAA;AAC3B,IAAA,MAAM,SAAS,MAAM,IAAA,CAAK,EAAG,CAAA,QAAQ,EAClC,MAAO,CAAA,MAAM,CACb,CAAA,KAAA,CAAM,EAAE,IAAY,EAAA,SAAA,EAAsB,IAAW,EAAC,EACtD,KAAM,EAAA,CAAA;AAET,IAAA,IAAIC,SAAO,MAAQ,EAAA,IAAA,CAAA;AAEnB,IAAI,IAAAC,YAAA,CAAMD,MAAI,CAAG,EAAA;AACf,MAAAA,MAAA,GAAOE,OAAO,EAAA,CAAA;AAEd,MAAA,MAAM,IAAK,CAAA,EAAA,CAAG,QAAQ,CAAA,CACnB,MAAO,CAAA;AAAA,cACNF,MAAA;AAAA,QACA,IAAA;AAAA,QACA,SAAA;AAAA,QACA,IAAA;AAAA,OACD,EACA,UAAW,CAAA,CAAC,QAAQ,WAAa,EAAA,MAAM,CAAC,CAAA,CACxC,MAAO,EAAA,CAAA;AAAA,KACZ;AAEA,IAAA,OAAO,QAAEA,MAAK,EAAA,CAAA;AAAA,GAChB;AACF;;;;"}